Generate PowerShell docs from code - #935
Draft
Michael Flanakin (flanakin) wants to merge 2 commits into
Draft
Conversation
microsoft-github-policy-service
Bot
requested a review
from Arthur Clares (arthurclares)
August 27, 2024 07:19
Collaborator
|
Removed assignment and "Needs Review" tag while the PR is still on Draft |
Michael Flanakin (flanakin)
force-pushed
the
flanakin/dev/ps-docs
branch
from
September 3, 2024 10:09
5bfbe9e to
a43affd
Compare
Michael Flanakin (flanakin)
marked this pull request as ready for review
September 3, 2024 10:10
Michael Flanakin (flanakin)
requested a review
from Anthony Romano (aromano2)
as a code owner
September 3, 2024 10:10
Arthur Clares (arthurclares)
removed their request for review
September 5, 2024 23:06
Michael Flanakin (flanakin)
marked this pull request as draft
April 2, 2025 18:32
microsoft-github-policy-service
Bot
requested review from
Arthur Clares (arthurclares)
April 2, 2025 18:33
Collaborator
Author
|
🤖 [AI] This comment is stale/no longer actionable — it was about draft-status housekeeping. No action needed; work on this PR is resuming with an updated approach (regenerating docs to match the current MS Learn format instead of the old Jekyll docs). |
…nd reference docs Adds src/scripts/Build-Documentation.ps1, which regenerates the MS Learn PowerShell command reference pages under docs-mslearn/toolkit/powershell/ from each command's comment-based help (based on the parsing approach from the never-merged PR #935, retargeted to the current MS Learn template instead of the old Jekyll docs/_automation format). Ports forward the comment-based help improvements from PR #935 where dev's current help didn't already cover them, and fixes several pre-existing doc bugs surfaced by generation: wrong/stale parameter names (DataSet vs Dataset, -ResourceGroup vs -ResourceGroupName), the "how to use the what {Command}" customer-intent typo, single-quoted vs backtick-wrapped parameter names, a wrong command name in a customer-intent comment, a copy-pasted example title, a stale RunHistory return-value shape, and several commands (Deploy-FinOpsHub, New-FinOpsCostExport) whose docs were missing parameters added to source since the doc was last hand-written. Adds the previously-undocumented Add-FinOpsHubScope command's reference page and lists it (plus other previously-missing commands) in the index pages. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Michael Flanakin (flanakin)
force-pushed
the
flanakin/dev/ps-docs
branch
from
August 27, 2026 06:31
a43affd to
bad3f57
Compare
microsoft-github-policy-service
Bot
requested a review
from Brett Wilson (MSBrett)
August 27, 2026 06:33
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🛠️ Description
Generate PowerShell documentation from code comments.
📋 Checklist
🔬 How did you test this change?
🙋♀️ Do any of the following that apply?
📑 Did you update
docs/changelog.md?📖 Did you update documentation?